<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<title>Docs For Class Config</title>
	<link rel="stylesheet" type="text/css" href="../media/style.css">
	<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>

<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
  <tr>
	<td class="header-top-left"><img src="../media/logo.png" border="0" alt="phpDocumentor " /></td>
    <td class="header-top-right">Buan<br /><div class="header-top-right-subpackage"></div></td>
  </tr>
  <tr><td colspan="2" class="header-line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
  <tr>
    <td colspan="2" class="header-menu">
      
                        
                      		[ <a href="../classtrees_Buan.html" class="menu">class tree: Buan</a> ]
		[ <a href="../elementindex_Buan.html" class="menu">index: Buan</a> ]
            [ <a href="../elementindex.html" class="menu">all elements</a> ]
    </td>
  </tr>
  <tr><td colspan="2" class="header-line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
</table>

<table width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="195" class="menu">
		<div class="package-title">Buan</div>
  <div class="package">
	<div id="todolist">
			<p><a href="../todolist.html">Todo List</a></p>
	</div>
	</div>
      <b>Packages:</b><br />
  <div class="package">
              <a href="../li_Buan.html">Buan</a><br />
      	</div>
      <br />
                        <b>Files:</b><br />
        <div class="package">
				<span style="padding-left: 1em;"><a href="../Buan/_BuanAutoLoader.php.html">BuanAutoLoader.php</a></span><br />
			<span style="padding-left: 1em;"><a href="../Buan/_BuanConfig.php.html">BuanConfig.php</a></span><br />
			<span style="padding-left: 1em;"><a href="../Buan/_BuanController.php.html">BuanController.php</a></span><br />
			<span style="padding-left: 1em;"><a href="../Buan/_BuanCore.php.html">BuanCore.php</a></span><br />
			<span style="padding-left: 1em;"><a href="../Buan/_BuanDatabase.php.html">BuanDatabase.php</a></span><br />
			<span style="padding-left: 1em;"><a href="../Buan/_BuanException.php.html">BuanException.php</a></span><br />
			<span style="padding-left: 1em;"><a href="../Buan/_BuanExtension.php.html">BuanExtension.php</a></span><br />
			<span style="padding-left: 1em;"><a href="../Buan/_BuanInflector.php.html">BuanInflector.php</a></span><br />
			<span style="padding-left: 1em;"><a href="../Buan/_BuanModel.php.html">BuanModel.php</a></span><br />
			<span style="padding-left: 1em;"><a href="../Buan/_BuanModelCollection.php.html">BuanModelCollection.php</a></span><br />
			<span style="padding-left: 1em;"><a href="../Buan/_BuanModelCriteria.php.html">BuanModelCriteria.php</a></span><br />
			<span style="padding-left: 1em;"><a href="../Buan/_BuanModelCriteriaGroup.php.html">BuanModelCriteriaGroup.php</a></span><br />
			<span style="padding-left: 1em;"><a href="../Buan/_BuanModelManager.php.html">BuanModelManager.php</a></span><br />
			<span style="padding-left: 1em;"><a href="../Buan/_BuanModelRelation.php.html">BuanModelRelation.php</a></span><br />
			<span style="padding-left: 1em;"><a href="../Buan/_BuanModelTracker.php.html">BuanModelTracker.php</a></span><br />
			<span style="padding-left: 1em;"><a href="../Buan/_BuanObject.php.html">BuanObject.php</a></span><br />
			<span style="padding-left: 1em;"><a href="../Buan/_BuanPdoStatementWrapper.php.html">BuanPdoStatementWrapper.php</a></span><br />
			<span style="padding-left: 1em;"><a href="../Buan/_BuanPdoWrapper.php.html">BuanPdoWrapper.php</a></span><br />
			<span style="padding-left: 1em;"><a href="../Buan/_BuanSystemLog.php.html">BuanSystemLog.php</a></span><br />
			<span style="padding-left: 1em;"><a href="../Buan/_BuanSystemLogEntry.php.html">BuanSystemLogEntry.php</a></span><br />
			<span style="padding-left: 1em;"><a href="../Buan/_BuanUrlCommand.php.html">BuanUrlCommand.php</a></span><br />
			<span style="padding-left: 1em;"><a href="../Buan/_BuanView.php.html">BuanView.php</a></span><br />
	  </div>
  <div class="package">
	<strong>ViewHelper</strong><br />			<span style="padding-left: 1em;"><a href="../Buan/ViewHelper/_view-helper---BuanViewHelperHtml.php.html">BuanViewHelperHtml.php</a></span><br />
			<span style="padding-left: 1em;"><a href="../Buan/ViewHelper/_view-helper---BuanViewHelperI18n.php.html">BuanViewHelperI18n.php</a></span><br />
	  </div>
            <br />
                  <b>Classes:</b><br />
        <div class="package">
		    		<a href="../Buan/AutoLoader.html">AutoLoader</a>    	 <br />
	    		<a href="../Buan/Config.html">Config</a>    	 <br />
	    		<a href="../Buan/Controller.html">Controller</a>    	 <br />
	    		<a href="../Buan/Core.html">Core</a>    	 <br />
	    		<a href="../Buan/Database.html">Database</a>    	 <br />
	    		<a href="../Buan/Exception.html">Exception</a>    	 <br />
	    		<a href="../Buan/Extension.html">Extension</a>    	 <br />
	    		<a href="../Buan/Inflector.html">Inflector</a>    	 <br />
	    		<a href="../Buan/Model.html">Model</a>    	 <br />
	    		<a href="../Buan/ModelCollection.html">ModelCollection</a>    	 <br />
	    		<a href="../Buan/ModelCriteria.html">ModelCriteria</a>    	 <br />
	    		<a href="../Buan/ModelCriteriaGroup.html">ModelCriteriaGroup</a>    	 <br />
	    		<a href="../Buan/ModelManager.html">ModelManager</a>    	 <br />
	    		<a href="../Buan/ModelRelation.html">ModelRelation</a>    	 <br />
	    		<a href="../Buan/ModelTracker.html">ModelTracker</a>    	 <br />
	    		<a href="../Buan/Object.html">Object</a>    	 <br />
	    		<a href="../Buan/PdoStatementWrapper.html">PdoStatementWrapper</a>    	 <br />
	    		<a href="../Buan/PdoWrapper.html">PdoWrapper</a>    	 <br />
	    		<a href="../Buan/SystemLog.html">SystemLog</a>    	 <br />
	    		<a href="../Buan/SystemLogEntry.html">SystemLogEntry</a>    	 <br />
	    		<a href="../Buan/UrlCommand.html">UrlCommand</a>    	 <br />
	    		<a href="../Buan/View.html">View</a>    	 <br />
	  </div>
  <div class="package">
	ViewHelper<br />	    <span style="padding-left: 1em;">		<a href="../Buan/ViewHelper/Html.html">Html</a>    </span>	 <br />
	    <span style="padding-left: 1em;">		<a href="../Buan/ViewHelper/I18n.html">I18n</a>    </span>	 <br />
	  </div>
                </td>
    <td>
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">

<h1>Class: Config</h1>
Source Location: /BuanConfig.php<br /><br />

<h2 class="class-name">Class Config</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Class Overview</div>
	<div class="nav-bar">
					<span class="disabled">Class Overview</span>
						
											| <a href="#sec-var-summary">Property Summary</a> | <a href="#sec-vars">Properties Detail</a>
														| <a href="#sec-method-summary">Method Summary</a> | <a href="#sec-methods">Methods Detail</a>
								</div>
	<div class="info-box-body">
		<table width="100%" border="0">
		<tr><td valign="top" width="60%" class="class-overview">

        		<p align="center" class="short-description"><strong>A method for storing and retrieving application-wide configuration variables.
</strong></p>
<span class="description"><p>Variables are accessed through a dot-notation syntax.</p></span>
		<p class="notes">
			Located in <a class="field" href="_BuanConfig.php.html">/BuanConfig.php</a> [<span class="field">line <a href="../__filesource/fsource_Buan__BuanConfig.php.html#a9">9</a></span>]
		</p>

		
		<pre></pre>

		
		
		
		</td>

				<td valign="top" width="20%" class="class-overview">
		<p align="center" class="short-description"><strong><a href="#sec_vars">Properties</a></strong></p>
		<ul>
		  		  <li><a href="../Buan/Config.html#var$var">$var</a></li>
		  		  <li><a href="../Buan/Config.html#var$_getCache">$_getCache</a></li>
		  		</ul>
		</td>
		
				<td valign="top" width="20%" class="class-overview">
		<p align="center" class="short-description"><strong><a href="#sec_methods">Methods</a></strong></p>
		<ul>
		  		  <li><a href="../Buan/Config.html#methodcreateNamespace">createNamespace</a></li>
		  		  <li><a href="../Buan/Config.html#methodget">get</a></li>
		  		  <li><a href="../Buan/Config.html#methodis_set">is_set</a></li>
		  		  <li><a href="../Buan/Config.html#methodset">set</a></li>
		  		</ul>
		</td>
		
		</tr></table>
		<div class="top">[ <a href="#top">Top</a> ]</div>
	</div>
</div>




	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Property Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Class Overview</a>
									| <span class="disabled">Property Summary</span> | <a href="#sec-vars">Properties Detail</a>
												| <a href="#sec-method-summary">Method Summary</a> | <a href="#sec-methods">Methods Detail</a>
							    				</div>
		<div class="info-box-body">
			<div class="var-summary">
			<table border="0" cellspacing="0" cellpadding="0" class="var-summary">
										<div class="var-title">
					<tr><td class="var-title">static <span class="var-type-summary">array</span>&nbsp;&nbsp;</td>
					<td class="var-title"><a href="#$var" title="details" class="var-name-summary">$var</a>&nbsp;&nbsp;</td>
					<td class="var-summary-description">Stores all variables in an associative array.</td></tr>
				</div>
													<div class="var-title">
					<tr><td class="var-title">static <span class="var-type-summary">array</span>&nbsp;&nbsp;</td>
					<td class="var-title"><a href="#$_getCache" title="details" class="var-name-summary">$_getCache</a>&nbsp;&nbsp;</td>
					<td class="var-summary-description">Stores an in-memory cache of the results of all calls to Config::get() in  order to speed things up. This entire cache is cleared whenever a call to  Config::set() is made.</td></tr>
				</div>
																									</table>
			</div>
			<br /><div class="top">[ <a href="#top">Top</a> ]</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Class Overview</a>
																		| <a href="#sec-var-summary">Property Summary</a> | <a href="#sec-vars">Properties Detail</a>
							    					| <span class="disabled">Method Summary</span> | <a href="#sec-methods">Methods Detail</a>
		</div>
		<div class="info-box-body">
			<div class="method-summary">
				<table border="0" cellspacing="0" cellpadding="0" class="method-summary">
												<div class="method-definition">
					<tr><td class="method-definition">static
											<span class="method-result">array</span>&nbsp;&nbsp;
					</td>
					<td class="method-definition"><a href="#createNamespace" title="details" class="method-name">createNamespace</a>()&nbsp;&nbsp;</td>
					<td class="method-definition">Creates the specified namespace tree and returns a reference to it.</td></tr>
				</div>
																<div class="method-definition">
					<tr><td class="method-definition">static
											<span class="method-result">mixed</span>&nbsp;&nbsp;
					</td>
					<td class="method-definition"><a href="#get" title="details" class="method-name">get</a>()&nbsp;&nbsp;</td>
					<td class="method-definition">Returns a config variable or a namespace tree</td></tr>
				</div>
																<div class="method-definition">
					<tr><td class="method-definition">static
											<span class="method-result">bool</span>&nbsp;&nbsp;
					</td>
					<td class="method-definition"><a href="#is_set" title="details" class="method-name">is_set</a>()&nbsp;&nbsp;</td>
					<td class="method-definition">Determines if the specified variable exists.</td></tr>
				</div>
																<div class="method-definition">
					<tr><td class="method-definition">static
											<span class="method-result">bool</span>&nbsp;&nbsp;
					</td>
					<td class="method-definition"><a href="#set" title="details" class="method-name">set</a>()&nbsp;&nbsp;</td>
					<td class="method-definition">Sets the specified config variable.</td></tr>
				</div>
																																																</table>
			</div>
			<br /><div class="top">[ <a href="#top">Top</a> ]</div>
		</div>
	</div>

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Properties</div>
		<div class="nav-bar">
			<a href="#sec-description">Class Overview</a>
													| <a href="#sec-var-summary">Property Summary</a> | <span class="disabled">Properties Detail</span>
															| <a href="#sec-method-summary">Method Summary</a> | <a href="#sec-methods">Methods Detail</a>
												</div>
		<div class="info-box-body">
			<a name="var$var" id="$var"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			static <span class="var-type">array</span>&nbsp;&nbsp;
			<span class="var-name">$var</span>
			 = <span class="var-default">array()</span>			<span class="smalllinenumber">[line <a href="../__filesource/fsource_Buan__BuanConfig.php.html#a25">25</a>]</span>
		</span>
	</div>

	<p align="center" class="short-description"><strong>Stores all variables in an associative array.
</strong></p>
	<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
<br />


	
		<br />
	<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="var$_getCache" id="$_getCache"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			static <span class="var-type">array</span>&nbsp;&nbsp;
			<span class="var-name">$_getCache</span>
			 = <span class="var-default">array()</span>			<span class="smalllinenumber">[line <a href="../__filesource/fsource_Buan__BuanConfig.php.html#a18">18</a>]</span>
		</span>
	</div>

	<p align="center" class="short-description"><strong>Stores an in-memory cache of the results of all calls to Config::get() in  order to speed things up. This entire cache is cleared whenever a call to  Config::set() is made.
</strong></p>
	<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
<br />


	
		<br />
	<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
		</div>
	</div>

	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Class Overview</a>
																		| <a href="#sec-var-summary">Property Summary</a> | <a href="#sec-vars">Properties Detail</a>
																	| <a href="#sec-method-summary">Method Summary</a> | <span class="disabled">Methods Detail</span>
					</div>
		<div class="info-box-body">
			<a name='method_detail'></a>
<a name="methodcreateNamespace" id="createNamespace"><!-- --></a>
<div class="evenrow">

<div class="method-header">
	<span class="method-title">static method createNamespace</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Buan__BuanConfig.php.html#a33">33</a>]</span>
</div>
<br />

	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
		<code>static array createNamespace(
string
$namespace&nbsp;
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

	<p align="center" class="short-description"><strong>Creates the specified namespace tree and returns a reference to it.
</strong></p>

			<strong>Parameters:</strong><br />
			<table border="0" cellspacing="0" cellpadding="0">
					<tr><td class="indent">
				<span class="var-type">string</span>&nbsp;&nbsp;</td>
				<td>
				<span class="var-name">$namespace:&nbsp;</span></td>
				<td>
				<span class="var-description"> Namespace to create (dot-notation, eg. &quot;app.dir.views&quot;)</span>			</td></tr>
				</table>

	<br />
	<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


		
		<br />
	<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodget" id="get"><!-- --></a>
<div class="oddrow">

<div class="method-header">
	<span class="method-title">static method get</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Buan__BuanConfig.php.html#a57">57</a>]</span>
</div>
<br />

	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
		<code>static mixed get(
[string
$path = NULL]&nbsp;
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

	<p align="center" class="short-description"><strong>Returns a config variable or a namespace tree
</strong></p>

			<strong>Parameters:</strong><br />
			<table border="0" cellspacing="0" cellpadding="0">
					<tr><td class="indent">
				<span class="var-type">string</span>&nbsp;&nbsp;</td>
				<td>
				<span class="var-name">$path:&nbsp;</span></td>
				<td>
				<span class="var-description"> Variable to retreive (dot-notation)</span>			</td></tr>
				</table>

	<br />
	<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


		
		<br />
	<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodis_set" id="is_set"><!-- --></a>
<div class="evenrow">

<div class="method-header">
	<span class="method-title">static method is_set</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Buan__BuanConfig.php.html#a45">45</a>]</span>
</div>
<br />

	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
		<code>static bool is_set(
string
$path&nbsp;
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

	<p align="center" class="short-description"><strong>Determines if the specified variable exists.
</strong></p>

			<strong>Parameters:</strong><br />
			<table border="0" cellspacing="0" cellpadding="0">
					<tr><td class="indent">
				<span class="var-type">string</span>&nbsp;&nbsp;</td>
				<td>
				<span class="var-name">$path:&nbsp;</span></td>
				<td>
				<span class="var-description"> Check if this variable exists (dot-notation, eg. &quot;app.dir.views&quot;)</span>			</td></tr>
				</table>

	<br />
	<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


		
		<br />
	<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodset" id="set"><!-- --></a>
<div class="oddrow">

<div class="method-header">
	<span class="method-title">static method set</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Buan__BuanConfig.php.html#a80">80</a>]</span>
</div>
<br />

	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
		<code>static bool set(
string
$varName, mixed
$varValue&nbsp;
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

	<p align="center" class="short-description"><strong>Sets the specified config variable.
</strong></p>
<span class="description"><p>Example:  <ol><li><div class="src-line">&nbsp;\<span class="src-id">Buan</span>\<span class="src-id"><a href="../Buan/Config.html">Config</a></span><span class="src-sym">::</span><a href="../Buan/Config.html#methodset">set</a><span class="src-sym">(</span><span class="src-str">'app.dir'</span><span class="src-sym">,&nbsp;</span><span class="src-key">array</span><span class="src-sym">(</span><span class="src-str">'views'</span>=&gt;<span class="src-str">'A'</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;\<span class="src-id">Buan</span>\<span class="src-id"><a href="../Buan/Config.html">Config</a></span><span class="src-sym">::</span><a href="../Buan/Config.html#methodget">get</a><span class="src-sym">(</span><span class="src-str">'app.dir.views'</span><span class="src-sym">)</span>===<span class="src-str">'A'</span><span class="src-sym">;</span></div></li>
</ol></p></span>
			<strong>Parameters:</strong><br />
			<table border="0" cellspacing="0" cellpadding="0">
					<tr><td class="indent">
				<span class="var-type">string</span>&nbsp;&nbsp;</td>
				<td>
				<span class="var-name">$varName:&nbsp;</span></td>
				<td>
				<span class="var-description"> Variable to set (dot-notation, eg. &quot;app.dir.views&quot;)</span>			</td></tr>
					<tr><td class="indent">
				<span class="var-type">mixed</span>&nbsp;&nbsp;</td>
				<td>
				<span class="var-name">$varValue:&nbsp;</span></td>
				<td>
				<span class="var-description"> Value to store.</span>			</td></tr>
				</table>

	<br />
	<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


		
		<br />
	<div class="top">[ <a href="#top">Top</a> ]</div>
</div>

		</div>
	</div>


        <div class="credit">
		    <hr class="separator" />
		    Documentation generated on Tue, 04 Aug 2009 19:58:56 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.1</a>
	      </div>
      </td></tr></table>
    </td>
  </tr>
</table>

</body>
</html>